home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 April / macformat-023.iso / Shareware City / Science / QUAD Plot / QUAD-PLOT Help next >
Encoding:
Text File  |  1994-11-08  |  20.7 KB  |  397 lines  |  [TEXT/ttxt]

  1. \title{Introduction}
  2. {QUAD-Plot was designed with ease of use foremost in mind. Many of the current plotting packages make preparing a simple graph a laborious process. In QUAD-Plot a high quality graph can be produced by simply dragging a text file over the QUAD-Plot icon and selecting GO! from the PLOT menu!
  3.  
  4. Frequently in science one produces an ASCII data file and would like to plot one or more pairs of columns against each other or perhaps compare this data with the results of a previous calculation. One does not want to spend minutes first importing the data file and yet more minutes trying to adjust the plot characteristics so that the result doesn't look clunky and primitive or, worse still, misleading. 
  5.  
  6. In QUAD-Plot we tried to produce a friendly and fast means of viewing and printing plots of scientific data.
  7.  
  8. If you have any suggestions or comments, or if you find any bugs, then please contact Robin Harmon either by EMAIL at harmon@wfpc3.la.asu.edu or by regular mail at the registration address. Queries by regular mail will take 14 days or more to be answered (due to forwarding delays).}
  9.  
  10. \subTitle{Aims}
  11. {• Simple importation of SPACE or TAB separated text files.
  12.  
  13. • Import and view datasets of size limited by computer memory only.
  14.  
  15. • Intelligent default values for plot characteristics.
  16.  
  17. • Fast plotting of data, either XY-pairs or histograms. 
  18.  
  19. • Convenience in viewing multiple plots on one screen.
  20.  
  21. • Easy and intuitive selection and modification of individual datasets on a plot.
  22.  
  23. • Ease in producing a printed copy of a plot.
  24. }
  25.  
  26. \subTitle{Features}
  27. {Importation of data: 
  28. ------------------
  29. 1. SPACE or TAB separated files imported either by drag-and-drop or via. a standard file dialog.
  30.  
  31. 2. The limit on the size of file is set by the available memory.
  32.  
  33. 3. Files may contain comments,  preceded by a percent sign. They may also contain blank lines.
  34.  
  35. 4. PC or Mac text files imported with no fuss.
  36.  
  37. Plotting Graphs:
  38. --------------
  39. 1. Columns to be plotted are selected on menus.
  40.  
  41. 2. Data can be drawn as (x,y) pairs or binned and drawn as a histogram.
  42.  
  43. 3. Symbols can be chosen from a pallet of 25.
  44.  
  45. 4. A range of line styles may be used to connect the data.
  46.  
  47. 5. Lines and symbols can have one of eight colors.
  48.  
  49. 6. Data can have error-bars easily attatched and modified.
  50.  
  51. Viewing Graphs:
  52. ---------------
  53. 1. Intelligent defaults are used to ensure that a plot is immediately of good quality.
  54.  
  55. 2. Windows can be re-sized and their plot re-sizes automatically to enable many windows to be viewed at once on the screen.
  56.  
  57. Editing Graphs:
  58. --------------
  59. 1. A dataset can be easily selected by clicking next to one of its points (or bins).
  60.  
  61. 2. Cutting and pasting datasets is like working with text in a word-processor.
  62.  
  63. 3. A dataset can be easily cut from one window and pasted into another.
  64.  
  65. Printing Graphs:
  66. ---------------
  67. 1. Plots may easily be printed on a page.
  68.  
  69. 2. Hairlines can be used to take advantage of the high resolution of a printer.
  70.  
  71. Exporting Graphs and Data:
  72. -------------------------
  73. 1. Plots can be exported as PICTs.
  74.  
  75. 2. The resolution of a PICT can be kept high for quality printing when included in another document.
  76.  
  77. 3. Individual datasets may be exported as text files.
  78.  
  79. Speed:
  80. ------
  81. 1. QUAD-Plot is faster than most other commercial packages at importing and plotting data.
  82.  
  83. Help:
  84. -----
  85. 1. A convenient on-line help system can be read while you use the application.
  86.  
  87. REQUIREMENTS.
  88. --------------
  89.     QUAD-Plot will work on any Mac running System 7.0 or later with at least 768 kilobytes of free memory. The default memory allocation allows up to about 50,000 points to be plotted.
  90. }
  91.  
  92.  
  93. \title{Registration}
  94. {DISTRIBUTION.
  95. -------------
  96.     The QUAD-Plot application is SHAREWARE. If you decide that you like it please send the shareware fee to the addresse below. The unregistered version of the program may be distributed freely provided it is unaltered and distributed complete with any associated files. 
  97.  
  98. REGISTRATION.
  99. --------------
  100.     The unregistered version of QUAD-Plot is a useful program, allowing the visualization and printing of data. Plots can be exported as a PICT file and incorporated into other programs such as one of the popular word-processers. 
  101.  
  102.     The "Save" and "Save As" features are, however, disabled. Payment of the shareware fee will unlock these menu options. It will also allow registered users to download and access all the features of minor upgrade versions of QUAD-Plot ie. versions 1.x. The next major version upgrade will be available at a discount to registered users.
  103.  
  104. In order to register please send $20 in the form of a check, cash or money order to this address:
  105.  
  106. Robin Harmon
  107. c/o Alan Murray
  108. 3029 Creekview Drive
  109. TX 76051
  110. U.S.A.
  111.  
  112. Make checks payable to Robin Harmon.  Please include a CLEARLY writen name to whoom the software is to be registered . 
  113.  
  114. MULTIPLE COPIES.
  115. ----------------
  116.     Each registration fee entitles you to use one copy of QUAD-Plot at a time. If you wish to use more then you must pay for each additional copy. If, however, you order more than 5 copies then the additional ones cost just $10.
  117.  
  118. NO WARRANTY.
  119. --------------
  120.     THIS PROGRAM IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL, BUT WITHOUT ANY WARRANTY; WITHOUT EVEN THE WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
  121.     
  122.   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  123. }
  124.  
  125.  
  126. \title{A Quick Plot}
  127. {To Create A Plot:
  128. ----------------
  129. 1.  Drag a text file icon over the QUAD-Plot icon. This will import the text file.
  130.  
  131. 2.    Select "Go!" on the Plot menu (Command G). This will cause the second column to be plotted against the first in the default symbol and without lines joining the points. 
  132.  
  133.  
  134. To Modify A Plot:
  135. ----------------
  136. 1.  Click in the plot window near a point of the dataset you wish to modify. This will select that dataset.
  137.  
  138. 2.  Change the dataset characteristics reflected on the menus.
  139.  
  140. 3.  Click outside the plot border to remove selection of this dataset or click near another dataset to select it.
  141.  
  142.  
  143. To Print A Plot:
  144. --------------
  145. 1.  Check "Page Setup" on the Files menu. Is the correct printer selected?
  146.  
  147. 2. Check "Resolution/Size" on the Files menu. Is the plot size OK? Are you happy with the line-widths to be used?
  148.  
  149. 3.  Select "Print" on the Files menu.
  150.  
  151. To Save A Plot:
  152. --------------
  153. 1.  Select "Save As" on the files menu.
  154. }
  155.  
  156.  
  157. \title{FILES}
  158. {The Files menu deals with the input and output of QUAD-Plot files, import and export of data, the printing of QUAD-Plot windows/files and exiting the application.
  159.  }
  160.  
  161. \subTitle{New} {Opens an empty window for subsequent plotting operations. }
  162.  
  163. \subTitle{Open} {Opens an existing QUAD-Plot file. }
  164.  
  165. \subTitle{Close} {Closes the frontmost window, prompting if it may need to be saved first. }
  166.  
  167. \subTitle{Save} {Saves the frontmost window. }
  168.  
  169. \subTitle{Save As} {Saves the frontmost window under a new name. }
  170.  
  171. \subTitle{Import} 
  172. {Prompts for the name of a file to import. 
  173.  
  174. QUAD-Plot can import a text file of data with columns separated by space(s) or TAB(s). 
  175.  
  176. • Any text following a percent sign is treated as a comment and ignored.
  177.  
  178. • Blank lines are ignored.
  179.  
  180. • PC generated text files are read without problem.
  181.  
  182. • Each row of data in the file should contain the same number of columns.
  183.  
  184. • The maximum line length is 512 characters.
  185.  
  186. Memory.
  187. --------
  188.   The default allocation for QUAD-Plot is 768Kb. This will allow you to plot up to about 50,000 points in your windows. If you would like to work with larger datasets then increase the memory allocation by about 250Kb per 20,000 points to be plotted. You can do this by selecting the QUAD-Plot icon in the Finder and opening the Information option on the Files menu. Change the Prefered size and close the information panel.
  189. }
  190.  
  191. \subTitle{Release File}
  192. {QUAD-Plot will keep an imported file open until another is imported. 
  193.  
  194. If you would like to edit the currently imported file using another program then you must first release it with this menu option (or import another file).}
  195.  
  196. \subTitle{Export}
  197. {This menu has two options:
  198.  
  199. • Export Dataset. This option will export a selected dataset as a file of text separated by spaces.
  200.  
  201. • Export Plot as PICT. The entire plot will be written out as a PICT file. A dialog prompts for a scale factor to be applied to the resolution of the plot before writting it out. This is used to produce an image with higher resolution to be included in a document to be printed.
  202.  }
  203.  
  204. \subTitle{Resolution/Size}
  205. {Allows the size of the printed plot on a page and the thickness of its lines to be set.
  206.  
  207. • There are 3 possible choices of plot size and position on a page.:
  208.     - As on screen. The plot is printed at the same size as it appears on the screen, at the corner of the page.
  209.     - As in the zoomed-out view. The prefered width for the zoomed view is 7 inches and an aspect ratio of 2/3.
  210.     - Fill the page. The plot is scaled to fill the currently selected page size.
  211.  
  212. • The resolution of almost any printer is higher than that of a VDU and one would like to produce plots which take advantage of this. QUAD-Plot allows the user to set the width of the graph border and the lines attatched to data within the plot independently. The units of thickness are those of a pixel on the printer. 
  213.  }
  214.  
  215. \subTitle{Page Setup} {Selects the general page features for printing.}
  216. \subTitle{Print} {Sets the details of the printing job.}
  217. \subTitle{Save Preferences} {Saves the current settings of QUAD-Plot.}
  218. \subTitle{Quit} {Leaves the application QUAD-Plot.}
  219.  
  220.  
  221. \title{EDIT}
  222. {Datasets can be cut, copied or cleared from any window and pasted into any other. 
  223.  
  224. Some of these operations are reversible and the first item in the menu will indicate if this is so. 
  225.  
  226. Addition or removal of any dataset from a window will cause the ranges to be automatically adjusted to best display the window contents if the "Default" option is chosen on the ranges menu. 
  227.  
  228. In addition to operations involving individual datasets, the entire plot can be copied as a PICT to the clipboard. 
  229.  
  230. The hilite state can be changed so that only one point of a dataset is hilited when a dataset is selected.}
  231.  
  232. \subTitle{Undo} {Reverses the effects of the last editing operation (Cut or Paste) or last "Go".}
  233. \subTitle{Cut} {Deletes the currently selected dataset and copies it to the copy buffer.}
  234. \subTitle{Copy} {Copies the currently selected dataset to the copy buffer.}
  235. \subTitle{Paste} {Pastes the currently copied dataset into the frontmost window.}
  236. \subTitle{Clear} {Deletes the selected dataset.}
  237. \subTitle{Copy Plot} {Copies the entire plot to the clipboard.}
  238. \subTitle{Hilite All Points} {All data are hilited when you select a dataset in a plot window.}
  239. \subTitle{Hilite One Point} {Only the datum nearest the cursor is hilited when you select a dataset. 
  240.  
  241. This is preferable if you are dealing with datasets of more than say 1000 points.}
  242.  
  243.  
  244. \title{LABELS} {The labels on the frontmost plot and their characteristics can be adjusted through this menu.}
  245.  
  246. \subTitle{None} {No labels will be displayed on the current plot.}
  247.  
  248. \subTitle{Default} {The labels on the current plot will refer to the last file from which data was chosen. 
  249.  
  250. • The title is set to the name of the file.
  251.  
  252. • In XY-Plot mode the X and Y labels reflect the column numbers of the last dataset added.
  253.  
  254. • In Histogram mode the X label reflects the last column that was binned onto the plot and the Y label is set to the letter "N".
  255. }
  256.  
  257. \subTitle{User Defined} {The labels are set to those defined by you in the "Set User..." menu item.}
  258.  
  259. \subTitle{Set User} 
  260. {Presents a dialog in which you can enter strings for the X and Y labels and the plot title. In the dialog there are 2 buttons in addition to Cancel and OK.
  261.  
  262. • Defaults - copies of the default labels are written into the editable areas.
  263.  
  264. • Use - QUAD-Plot will switch to the "User" option on exiting the dialog.
  265. }
  266.  
  267. \subTitle{Font} {Permits selection of the font to be used for the X and Y labels and the plot title.}
  268. \subTitle{Size} {Permits selection of the font size to be used for the X and Y labels and the plot title.}
  269. \subTitle{Style} {Permits selection of the font style to be used for the X and Y labels and the plot title.}
  270.  
  271. \subTitle{Scale/Don't Scale} 
  272. {One of the convenient features of QUAD-Plot is that you can change the size of a window and its contents are scaled to the new size. This allows you to shrink your windows and view several of them on the screen at the same time without overlap. The full contents of each are visible albeit at a reduced size. 
  273.  
  274. The Scale/Don't Scale option affects the labels on the plot. If you choose "Scale" then the labels are scaled in size so that only in the zoomed-out view do they have the size you set in the "Size" sub-menu. If you choose "Don't Scale" then they are displayed at your selected size regardless of the window size.}
  275.  
  276.  
  277. \title{RANGES} {The coordinate ranges displayed on the frontmost plot can be adjusted through this menu. }
  278. \subTitle{Default} {The X and Y ranges on the current plot are set to be 10% larger than the absolute range of the data in the window.}
  279.  
  280. \subTitle{User Defined} {The coordinate ranges used to display the data are those defined by you in the "Set User..." menu item. 
  281.  
  282. If none have been set then they default to the interval from -1 to +1 in X and Y.}
  283.  
  284. \subTitle{Set User} 
  285. {Presents a dialog in which you can enter coordinate ranges in X and Y. The OK button is disabled if the current ranges are not readable.  There are 2 buttons in the dialog in addition to Cancel and OK.
  286.  
  287. • Defaults - copies of the default ranges are written into the editable areas.
  288.  
  289. • Use - QUAD-Plot will switch to the "User" option on exiting the dialog.
  290. }
  291.  
  292. \subTitle{Draw X-axis} {A coordinate axis will be drawn at Y = 0. Tick marks are drawn at the same positions as on the graph border.}
  293. \subTitle{Draw Y-axis} {A coordinate axis will be drawn at X = 0. Tick marks are drawn at the same positions as on the graph border.}
  294.  
  295. \subTitle{Justify/Don't Justify} 
  296. {
  297. • Justify -  equal coordinate intervals along the X and Y axes will have equal lengths on the screen (or page). 
  298.  
  299. • Don't Justify - the coordinate scales in X and Y will be chosen to fill the window and hence will be unequal in general.
  300. }
  301.  
  302.  
  303. \title{SYMBOLS} {The choice of symbol to be assigned to the next plotted dataset (or the currently selected one) is made using this menu. The symbol characteristics which may be set are size, color and whether or not it is scaled with the window size.}
  304.  
  305. \subTitle{None} {A convenient way of turning off symbols for the next dataset to be plotted or the currently selected one.}
  306.  
  307. \subTitle{Default} {Sets the symbol choice to be the next-to-smallest point which corresponds to the second symbol on the pallet.}
  308.  
  309. \subTitle{Pallet} {You may choose any symbol from this pallet.}
  310.  
  311. \subTitle{Size} {The size of the symbols attatched to the next dataset or the currently selected one are set here.}
  312.  
  313. \subTitle{Color} {The color of the symbols attatched to the next dataset or the currently selected one are set here.
  314.  
  315.     On a black and white monitor the color blocks beside each option are all white. You may still change the symbols' color so that when the plot is displayed on a color machine it is displayed in your chosen color.}
  316.  
  317. \subTitle{Scale/Don't Scale} 
  318. {This option is identical to that for the Labels around the plot border. The size of a symbol may be scaled with the window size for convenient viewing of many windows on one screen or you can insist that it have the size you choose at all window sizes.}
  319.  
  320.  
  321. \title{LINES} {The points in a dataset may be joined with a line drawn in one of a range of styles, widths and colors. The characteristics set on this menu will be assigned to the next plotted dataset (or the currently selected one).}
  322.  
  323. \subTitle{None} {A convenient way of turning off lines for the next dataset to be plotted or the currently selected one.}
  324.  
  325. \subTitle{Style} {Sets the line-style to be applied to the next dataset plotted or the currently selected one.}
  326.  
  327. \subTitle{Width} {You may draw the line in any width. The Resolution/Size menu option on the Files menu will determine the thickness of these lines on a page.}
  328.  
  329. \subTitle{Color} {The color of the line joining the points of the next dataset or the currently selected one is set here.
  330.  
  331.     On a black and white monitor the color blocks beside each option are all white. You may still change the lines' color so that when the plot is displayed on a color machine it is displayed in your chosen color.}
  332.  
  333.  
  334. \title{COLUMN(S)} {When a data file is Imported the Column menus change to reflect the number of columns in the file. The choice of which column to plot against which is made here. }
  335.  
  336. \subTitle{Errors}
  337. {Scientific data usually comes with errors attatched. At the bottom of each column menu there is an Errors sub-menu or item and this enables you to draw the error-bars on your data.
  338.  
  339. The available error-bar choices depend on the plot type but include:
  340.  
  341. Symmetric Error Bars.
  342.     - Fixed percent: the error-bar size is plus or minus a percentage of each data value.
  343.     - Poisson: the error-bar size is the square root of the magnitude of each data value.
  344.     - Column: the error-bar size is given by the data column selected.
  345.  
  346. Asymmetric Error-Bars.
  347.     - the minimum and maximum values are determined by two columns of data from the current data file.
  348.  
  349. • For XY-Plots:
  350.     - The New option disposes of any existing error structure attatched to the selected dataset and will use the currently imported file from which to get the new error information. If the current file has not got the same number of rows as the selected dataset then you may only choose error options which are independent of the current file.
  351.     - The Modify option allows you to keep the error structure currently attatched to the selected dataset but to choose one of the alternate options.
  352.  
  353. • For Histogram Plots:
  354.     - There are no options to add error-bars to binned data other than those where the error-bar magnitude is dependent on the number of items in the bin only. There is therefore no need for the New option.
  355.  
  356. Error-Bar Style:
  357.  Error-bars can be either the same color as the symbols or histogram bins to which they are attatched or black. They may be drawn with or without terminating cross-bars and they may have cross-bars of varying length. These options are presented in all Error dialog boxes.}
  358.  
  359.  
  360. \title{BINS} {When a histogram is being created or modified the menu-bar contains a Bins entry. This lists options related specifically to histograms such as the number of bins, the range over which to bin and whether to draw the binned data as a histogram or as a set of points optionally joined by lines.}
  361.  
  362. \subTitle{Number/Other} {Permits you to change the number of bins for either the next histogram to be drawn or for the currently selected one.} 
  363.  
  364. \subTitle{Bin Range} {Presents a dialog which you can use to set the range over which QUAD-Plot will bin the data.
  365.  
  366. Unlike the Ranges menu which controls what interval of the world coordinate space is visible on the plot, this option allows you to choose the range over which to bin the data. There are 3 choices:
  367.  
  368. • Full data Range:-  all of the data will be included in the binning process.
  369.  
  370. • Mean ±3 standard deviations:- the mean and standard deviation of the data are determined and the binning range restricted accordingly. This is useful as a quick way of looking at the data but will loose outliers.
  371.  
  372. • User Range:- you can input any range you like here.} 
  373.  
  374. \subTitle{Draw/Don't Draw} 
  375. {The binned data can be drawn either as:
  376.  
  377.     - a histogram,
  378.     - a histogram with a symbol at each bin-center,
  379.     - a line,
  380.     - a set of points, 
  381.     - a set of points joined by a line.
  382.  
  383. • If you choose Draw then the bins will be drawn in the line-style selected in the Lines menu. There may or may not be a symbol at each bin-center depending on the Symbols menu.
  384.  
  385. • If you choose Don't Draw then no bins will be drawn and the binned data will be marked by either lines or symbols or both depending on the state of the Lines and Symbols menus.
  386.  
  387.  
  388. \title{PLOT} {This menu controls the plot-type and causes a plot to be produced.}
  389.  
  390. \subTitle{Go!} {This menu instructs the application to Go ahead and add a dataset to the active window using the settings in the other menus}
  391.  
  392. \subTitle{XY-Plot} {This sets the type of the next plot to represent a set of X, Y pairs selected from the currently imported file.}
  393.  
  394. \subTitle{Histogram} {This sets the type of the next plot to represent a binned column of data from the currently imported file.}
  395.  
  396.